All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.music.ToneDescription

java.lang.Object
   |
   +----quicktime.util.QTByteObject
           |
           +----quicktime.std.music.ToneDescription

public final class ToneDescription

extends QTByteObject

implements QuickTimeLib, Cloneable

kNativeSize

This is the size (the number of bytes) that are required for this class

ToneDescription()

Creates a ToneDescription object with no initial settings.

ToneDescription(int)

Initializes the ToneDescription instance with the appropriate instrument based on the specified gmNumber.

ToneDescription(NoteAllocator, int)

Initializes the ToneDescription instance with the appropriate instrument based on the specified gmNumber.

clone()

Makes a copy of a ToneDescription object.

getGMNumber()

Returns the current gm Number of the described instrument's synthesiser.

getInstrumentName()

Returns the current name of the described instrument.

getInstrumentNumber()

Returns the current number of the described instrument.

getSynthesizerName()

Returns the current name of the described instrument's synthesiser.

getSynthesizerType()

Returns the current OSType of the described instrument's synthesiser.

pickInstrument(NoteAllocator, String, int)

Initialises the tone description structure through providing the user with a dialog that allows the user to choose the instrument.

setGMNumber(int)

Sets the current gm Number of the described instrument's synthesiser.

setInstrumentName(String)

Sets the current name of the described instrument.

setInstrumentNumber(int)

Sets the current number of the described instrument.

setSynthesizerName(String)

Sets the current name of the described instrument's synthesiser.

setSynthesizerType(int)

Sets the current OSType of the described instrument's synthesiser.

stuff(NoteAllocator, int)

Initializes the calling ToneDescription instance with the details of the note channel specified by the gmNumber.

toString()

Returns a string representation of this object

 public static final int kNativeSize

This is the size (the number of bytes) that are required for this class

 public ToneDescription()

Creates a ToneDescription object with no initial settings.

 public ToneDescription(int gmNumber) throws QTException

Initializes the ToneDescription instance with the appropriate instrument based on the specified gmNumber.

QuickTime::NAStuffToneDescription

Parameters:

gmNumber - instrument number

 public ToneDescription(NoteAllocator na,
                        int gmNumber) throws StdQTException

Initializes the ToneDescription instance with the appropriate instrument based on the specified gmNumber.

QuickTime::NAStuffToneDescription

Parameters:

na - the NoteAllocator component instance to use

gmNumber - instrument number

 public final int getSynthesizerType()

Returns the current OSType of the described instrument's synthesiser.

Returns:

the OSType

 public final void setSynthesizerType(int type)

Sets the current OSType of the described instrument's synthesiser.

Parameters:

type - the OSType

 public final String getSynthesizerName() throws UtilException

Returns the current name of the described instrument's synthesiser.

Returns:

the Synthesizer name

 public final void setSynthesizerName(String name) throws UtilException

Sets the current name of the described instrument's synthesiser.

Parameters:

name - the Synthesizer name

 public final String getInstrumentName() throws UtilException

Returns the current name of the described instrument.

Returns:

the instrumentName

 public final void setInstrumentName(String name) throws UtilException

Sets the current name of the described instrument.

Parameters:

name - the instrumentName

 public final int getInstrumentNumber()

Returns the current number of the described instrument.

Returns:

the instrumentNumber

 public final void setInstrumentNumber(int num)

Sets the current number of the described instrument.

Parameters:

num - the instrumentNumber

 public final int getGMNumber()

Returns the current gm Number of the described instrument's synthesiser.

Returns:

the gm Number

 public final void setGMNumber(int gmNumber)

Sets the current gm Number of the described instrument's synthesiser.

Parameters:

gmNumber - the gm Number

 public final void stuff(NoteAllocator na,
                         int gmNumber) throws StdQTException

Initializes the calling ToneDescription instance with the details of the note channel specified by the gmNumber.

QuickTime::NAStuffToneDescription

Parameters:

na - the Note Allocator component to use

gmNumber - instrument number

 public final void pickInstrument(NoteAllocator na,
                                  String prompt,
                                  int flags) throws StdQTException

Initialises the tone description structure through providing the user with a dialog that allows the user to choose the instrument.

QuickTime::NAPickInstrument

Parameters:

na - the Note Allocator component to use

prompt - Dialog box prompt "New Instrument..."

flags - flags to limit user options

 public String toString()

Returns a string representation of this object

Overrides:

toString in class QTByteObject

 public Object clone()

Makes a copy of a ToneDescription object.

Overrides:

clone in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index